Skip to content

Initial docs for StringRuneEnumerator and SpanRuneEnumerator #2821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Aug 6, 2019

Conversation

GrabYourPitchforks
Copy link
Member

Summary

Adds documentation for StringRuneEnumerator and SpanRuneEnumerator, which are enumerators returned by the String.EnumerateRunes and MemoryExtensions.EnumerateRunes methods. Developers should not use the enumerator types directly and should instead use syntax like the below:

foreach (Rune rune in myString.EnumerateRunes() /* or mySpan.EnumerateRunes() */)
{
    // use 'rune' here
}

The proposed text for the documentation is based somewhat on the existing text for the Span<T>+Enumerator type.

/cc @mairaw @rpetrusha @carlossanlop

@carlossanlop carlossanlop added 🏁 Release: .NET Core 3.0 :checkered_flag: Release: .NET Core 3.0 new-content Indicates PRs that contain new articles waiting-on-reviews Indicates PRs that cannot be merged because of the lack of reviews labels Jul 24, 2019
Copy link
Contributor

@carlossanlop carlossanlop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your PR. I left some comments for you to consider.

Copy link
Contributor

@mairaw mairaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good @GrabYourPitchforks! Left a few comments

@mairaw mairaw added this to the July 2019 milestone Jul 24, 2019
@mairaw mairaw removed the waiting-on-reviews Indicates PRs that cannot be merged because of the lack of reviews label Jul 24, 2019
@mairaw mairaw removed the request for review from rpetrusha July 24, 2019 22:48
@GrabYourPitchforks
Copy link
Member Author

Apologies for the noise - going through and applying suggestions, which will introduce a bunch of tiny commits to the PR.

Co-Authored-By: Carlos Sanchez Lopez <[email protected]>
Co-Authored-By: Maira Wenzel <[email protected]>
@mairaw
Copy link
Contributor

mairaw commented Aug 6, 2019

If you go to the Files changed tab, you can batch them in a single commit @GrabYourPitchforks 😉

Copy link
Contributor

@mairaw mairaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I've added the boilerplate remarks that we add for EIIs as well (I've recently added to the wiki published at https://github.com/dotnet/dotnet-api-docs/wiki/Remarks#explicit-interface-implementation)

@carlossanlop
Copy link
Contributor

@mairaw the build passed, so I think this is good to merge.

@carlossanlop
Copy link
Contributor

@rpetrusha this one's good to merge, the build passed.

@rpetrusha rpetrusha merged commit d2cd895 into dotnet:master Aug 6, 2019
@GrabYourPitchforks GrabYourPitchforks deleted the rune_docs branch September 24, 2019 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏁 Release: .NET Core 3.0 :checkered_flag: Release: .NET Core 3.0 new-content Indicates PRs that contain new articles
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants